<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>Tabs</title>
    <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="icon" href="../assets/favicon.ico">
    <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
                <h1><img src="../assets/css/logo.png" title="" width="117" height="52"></h1>
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: </em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
                    <h2 class="off-left">APIs</h2>
                    <div id="api-tabview" class="tabview">
                        <ul class="tabs">
                            <li><a href="#api-classes">Classes</a></li>
                            <li><a href="#api-modules">Modules</a></li>
                        </ul>
                
                        <div id="api-tabview-filter">
                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
                        </div>
                
                        <div id="api-tabview-panel">
                            <ul id="api-classes" class="apis classes">
                                <li><a href="../classes/Area.html">Area</a></li>
                                <li><a href="../classes/ContextMenu.html">ContextMenu</a></li>
                                <li><a href="../classes/Dialog.html">Dialog</a></li>
                                <li><a href="../classes/Inspector.html">Inspector</a></li>
                                <li><a href="../classes/LineEditor.html">LineEditor</a></li>
                                <li><a href="../classes/List.html">List</a></li>
                                <li><a href="../classes/LiteGUI.html">LiteGUI</a></li>
                                <li><a href="../classes/SearchBox.html">SearchBox</a></li>
                                <li><a href="../classes/Slider.html">Slider</a></li>
                                <li><a href="../classes/Split.html">Split</a></li>
                                <li><a href="../classes/Tabs.html">Tabs</a></li>
                                <li><a href="../classes/Tree.html">Tree</a></li>
                            </ul>
                
                
                            <ul id="api-modules" class="apis modules">
                            </ul>
                        </div>
                    </div>
                </div>
            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
                    Show:
                    <label for="api-show-inherited">
                        <input type="checkbox" id="api-show-inherited" checked>
                        Inherited
                    </label>
            
                    <label for="api-show-protected">
                        <input type="checkbox" id="api-show-protected">
                        Protected
                    </label>
            
                    <label for="api-show-private">
                        <input type="checkbox" id="api-show-private">
                        Private
                    </label>
                    <label for="api-show-deprecated">
                        <input type="checkbox" id="api-show-deprecated">
                        Deprecated
                    </label>
            
                </div>
            
            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
<h1>Tabs Class</h1>
<div class="box meta">


        <div class="foundat">
            Defined in: <a href="../files/.._src_tabs.js.html#l5"><code>..&#x2F;src&#x2F;tabs.js:5</code></a>
        </div>


</div>


<div class="box intro">
    <p>Widget that contains several tabs and their content
Options:</p>
<ul>
<li>mode: &quot;vertical&quot;,&quot;horizontal&quot;</li>
<li>size</li>
<li>width,height</li>
<li>autoswitch: allow autoswitch (switch when mouse over)</li>
</ul>

</div>

    <div class="constructor">
        <h2>Constructor</h2>
<div id="method_Tabs" class="method item">
    <h3 class="name"><code>Tabs</code></h3>

        <span class="paren">()</span>








    <div class="meta">
                <p>
                Defined in
        <a href="../files/.._src_tabs.js.html#l5"><code>..&#x2F;src&#x2F;tabs.js:5</code></a>
        </p>



    </div>

    <div class="description">
        
    </div>




</div>
    </div>

<div id="classdocs" class="tabview">
    <ul class="api-class-tabs">
        <li class="api-class-tab index"><a href="#index">Index</a></li>

            <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
    </ul>

    <div>
        <div id="index" class="api-class-tabpanel index">
            <h2 class="off-left">Item Index</h2>

                <div class="index-section methods">
                    <h3>Methods</h3>

                    <ul class="index-list methods">
                            <li class="index-item method">
                                <a href="#method_addTab">addTab</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getCurrentTab">getCurrentTab</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getCurrentTab">getCurrentTab</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getNumOfTabs">getNumOfTabs</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getTab">getTab</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getTabByIndex">getTabByIndex</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getTabContent">getTabContent</a>

                            </li>
                            <li class="index-item method">
                                <a href="#method_getTabIndex">getTabIndex</a>

                            </li>
                    </ul>
                </div>



        </div>

            <div id="methods" class="api-class-tabpanel">
                <h2 class="off-left">Methods</h2>

<div id="method_addTab" class="method item">
    <h3 class="name"><code>addTab</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>id</code>
                </li>
                <li class="arg">
                        <code>options</code>
                </li>
                <li class="arg">
                        <code>skip_event</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/.._src_tabs.js.html#l213"><code>..&#x2F;src&#x2F;tabs.js:213</code></a>
        </p>



    </div>

    <div class="description">
        <p>Create a new tab, where id is a unique identifier</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">id</code>
                        <span class="type">String</span>


                    <div class="param-description">
                        <p>could be null then a random id is generated</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">options</code>
                        <span class="type">Object</span>


                    <div class="param-description">
                        <p>{
title: tab text,
callback: called when selected,
callback_leave: callback when leaving,
callback_context: on right click on tab
callback_canopen: used to block if this tab can be opened or not (if it returns true then yes)
content: HTML content,
closable: if it can be closed (callback is onclose),
tab_width: size of the tab,
tab_className: classes for the tab element,
id: content id,
size: full means all,
mode: &quot;vertical&quot; or &quot;horizontal&quot;,
button: if it is a button tab, not a selectable tab
}</p>

                    </div>

                </li>
                <li class="param">
                        <code class="param-name">skip_event</code>
                        <span class="type">Bool</span>


                    <div class="param-description">
                        <p>prevent dispatching events</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>an object containing { id, tab, content }</p>

            </div>
        </div>


</div>
<div id="method_getCurrentTab" class="method item">
    <h3 class="name"><code>getCurrentTab</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/.._src_tabs.js.html#l110"><code>..&#x2F;src&#x2F;tabs.js:110</code></a>
        </p>



    </div>

    <div class="description">
        <p>Returns the currently selected tab in the form of a tab object</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the tab in the form of an object with {id,tab,content}</p>

            </div>
        </div>


</div>
<div id="method_getCurrentTab" class="method item">
    <h3 class="name"><code>getCurrentTab</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/.._src_tabs.js.html#l127"><code>..&#x2F;src&#x2F;tabs.js:127</code></a>
        </p>



    </div>

    <div class="description">
        <p>Returns the last tab pressed before this one. used to know from which tab we come</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the tab in the form of an object with {id,tab,content}</p>

            </div>
        </div>


</div>
<div id="method_getNumOfTabs" class="method item">
    <h3 class="name"><code>getNumOfTabs</code></h3>

        <span class="paren">()</span>

        <span class="returns-inline">
            <span class="type">Number</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/.._src_tabs.js.html#l169"><code>..&#x2F;src&#x2F;tabs.js:169</code></a>
        </p>



    </div>

    <div class="description">
        <p>Returns how many tabs there is</p>

    </div>


        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Number</span>:
                    <p>number of tabs</p>

            </div>
        </div>


</div>
<div id="method_getTab" class="method item">
    <h3 class="name"><code>getTab</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>id</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/.._src_tabs.js.html#l147"><code>..&#x2F;src&#x2F;tabs.js:147</code></a>
        </p>



    </div>

    <div class="description">
        <p>Returns a tab given its id</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">id</code>
                        <span class="type">String</span>


                    <div class="param-description">
                        <p>tab id</p>

                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the tab in the form of an object with {id,tab,content}</p>

            </div>
        </div>


</div>
<div id="method_getTabByIndex" class="method item">
    <h3 class="name"><code>getTabByIndex</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>index</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Object</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/.._src_tabs.js.html#l158"><code>..&#x2F;src&#x2F;tabs.js:158</code></a>
        </p>



    </div>

    <div class="description">
        <p>Returns a tab given its index in the tabs list</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">index</code>
                        <span class="type">Number</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Object</span>:
                    <p>the tab in the form of an object with {id,tab,content}</p>

            </div>
        </div>


</div>
<div id="method_getTabContent" class="method item">
    <h3 class="name"><code>getTabContent</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>id</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">HTMLEntity</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/.._src_tabs.js.html#l182"><code>..&#x2F;src&#x2F;tabs.js:182</code></a>
        </p>



    </div>

    <div class="description">
        <p>Returns the content HTML element of a tab</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">id</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">HTMLEntity</span>:
                    <p>content</p>

            </div>
        </div>


</div>
<div id="method_getTabIndex" class="method item">
    <h3 class="name"><code>getTabIndex</code></h3>

        <div class="args">
            <span class="paren">(</span><ul class="args-list inline commas">
                <li class="arg">
                        <code>id</code>
                </li>
            </ul><span class="paren">)</span>
        </div>

        <span class="returns-inline">
            <span class="type">Number</span>
        </span>







    <div class="meta">
                <p>
                Defined in
        <a href="../files/.._src_tabs.js.html#l195"><code>..&#x2F;src&#x2F;tabs.js:195</code></a>
        </p>



    </div>

    <div class="description">
        <p>Returns the index of a tab (the position in the tabs list)</p>

    </div>

        <div class="params">
            <h4>Parameters:</h4>

            <ul class="params-list">
                <li class="param">
                        <code class="param-name">id</code>
                        <span class="type">String</span>


                    <div class="param-description">
                         
                    </div>

                </li>
            </ul>
        </div>

        <div class="returns">
            <h4>Returns:</h4>

            <div class="returns-description">
                        <span class="type">Number</span>:
                    <p>index</p>

            </div>
        </div>


</div>
            </div>



    </div>
</div>
                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
